<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>CryptoAuthLib: atca_device.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">CryptoAuthLib
   </div>
   <div id="projectbrief">Microchip CryptoAuthentication Library</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('a00155_source.html','');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">atca_device.h</div>  </div>
</div><!--header-->
<div class="contents">
<a href="a00155.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;</div><div class="line"><a name="l00029"></a><span class="lineno">   29</span>&#160;<span class="preprocessor">#ifndef ATCA_DEVICE_H</span></div><div class="line"><a name="l00030"></a><span class="lineno">   30</span>&#160;<span class="preprocessor">#define ATCA_DEVICE_H</span></div><div class="line"><a name="l00031"></a><span class="lineno">   31</span>&#160;</div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00146.html">atca_command.h</a>&quot;</span></div><div class="line"><a name="l00033"></a><span class="lineno">   33</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="a00170.html">atca_iface.h</a>&quot;</span></div><div class="line"><a name="l00037"></a><span class="lineno">   37</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00038"></a><span class="lineno">   38</span>&#160;<span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;</div><div class="line"><a name="l00044"></a><span class="lineno"><a class="line" href="a01009.html">   44</a></span>&#160;<span class="keyword">struct </span><a class="code" href="a01009.html">atca_device</a></div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;{</div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="a01009.html#aac7a3ed180ba0fcf0d86f7b54ebc1379">   46</a></span>&#160;    <a class="code" href="a01001.html">ATCACommand</a> <a class="code" href="a01009.html#aac7a3ed180ba0fcf0d86f7b54ebc1379">mCommands</a>;  </div><div class="line"><a name="l00047"></a><span class="lineno"><a class="line" href="a01009.html#aca75c68806e47e95144dc86a3f50d236">   47</a></span>&#160;    <a class="code" href="a01041.html">ATCAIface</a>   <a class="code" href="a01009.html#aca75c68806e47e95144dc86a3f50d236">mIface</a>;     </div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;};</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;</div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="a00988.html#gaa94f7bb4af0a3d6735225cc85d92cb50">   50</a></span>&#160;<span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="a01009.html">atca_device</a> * <a class="code" href="a00988.html#gaa94f7bb4af0a3d6735225cc85d92cb50">ATCADevice</a>;</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;<a class="code" href="a00173.html#a22bd6643f31f1d75dc3e7ea939f468cd">ATCA_STATUS</a> <a class="code" href="a00988.html#ga8eec7f2190d1f9bda6684f5d2177db15">initATCADevice</a>(<a class="code" href="a01013.html">ATCAIfaceCfg</a>* cfg, <a class="code" href="a01009.html">ATCADevice</a> cadev);</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;<a class="code" href="a01009.html">ATCADevice</a> <a class="code" href="a00988.html#gad5e12e12d3030e28d75164286df9e5e9">newATCADevice</a>(<a class="code" href="a01013.html">ATCAIfaceCfg</a> *cfg);</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;<a class="code" href="a00173.html#a22bd6643f31f1d75dc3e7ea939f468cd">ATCA_STATUS</a> <a class="code" href="a00988.html#gab729e6c838c0a247d4f226fb92492d96">releaseATCADevice</a>(<a class="code" href="a01009.html">ATCADevice</a> ca_dev);</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;<span class="keywordtype">void</span> <a class="code" href="a00988.html#gac087cf04cd5bd6ff2e026d89bfbf5e12">deleteATCADevice</a>(<a class="code" href="a01009.html">ATCADevice</a> *ca_dev);</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno">   57</span>&#160;<a class="code" href="a01001.html">ATCACommand</a> <a class="code" href="a00988.html#gabf51c08f1928fc5ec44936f3117a9f7e">atGetCommands</a>(<a class="code" href="a01009.html">ATCADevice</a> <a class="code" href="a00993.html#gabe78755474c1323a5ac7b3dd6d03dedf">dev</a>);</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;<a class="code" href="a01041.html">ATCAIface</a> <a class="code" href="a00988.html#ga3f98e29cffa06446fc91b329703606af">atGetIFace</a>(<a class="code" href="a01009.html">ATCADevice</a> <a class="code" href="a00993.html#gabe78755474c1323a5ac7b3dd6d03dedf">dev</a>);</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;</div><div class="line"><a name="l00062"></a><span class="lineno">   62</span>&#160;<span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00063"></a><span class="lineno">   63</span>&#160;}</div><div class="line"><a name="l00064"></a><span class="lineno">   64</span>&#160;<span class="preprocessor">#endif</span></div><div class="line"><a name="l00065"></a><span class="lineno">   65</span>&#160;</div><div class="line"><a name="l00066"></a><span class="lineno">   66</span>&#160;<span class="preprocessor">#endif</span></div><div class="ttc" id="a00988_html_ga3f98e29cffa06446fc91b329703606af"><div class="ttname"><a href="a00988.html#ga3f98e29cffa06446fc91b329703606af">atGetIFace</a></div><div class="ttdeci">ATCAIface atGetIFace(ATCADevice dev)</div><div class="ttdoc">returns a reference to the ATCAIface interface object for the device</div><div class="ttdef"><b>Definition:</b> atca_device.c:155</div></div>
<div class="ttc" id="a01009_html_aca75c68806e47e95144dc86a3f50d236"><div class="ttname"><a href="a01009.html#aca75c68806e47e95144dc86a3f50d236">atca_device::mIface</a></div><div class="ttdeci">ATCAIface mIface</div><div class="ttdoc">Physical interface.</div><div class="ttdef"><b>Definition:</b> atca_device.h:47</div></div>
<div class="ttc" id="a00988_html_gac087cf04cd5bd6ff2e026d89bfbf5e12"><div class="ttname"><a href="a00988.html#gac087cf04cd5bd6ff2e026d89bfbf5e12">deleteATCADevice</a></div><div class="ttdeci">void deleteATCADevice(ATCADevice *ca_dev)</div><div class="ttdoc">destructor for a device NULLs reference after object is freed</div><div class="ttdef"><b>Definition:</b> atca_device.c:90</div></div>
<div class="ttc" id="a00988_html_gabf51c08f1928fc5ec44936f3117a9f7e"><div class="ttname"><a href="a00988.html#gabf51c08f1928fc5ec44936f3117a9f7e">atGetCommands</a></div><div class="ttdeci">ATCACommand atGetCommands(ATCADevice dev)</div><div class="ttdoc">returns a reference to the ATCACommand object for the device</div><div class="ttdef"><b>Definition:</b> atca_device.c:146</div></div>
<div class="ttc" id="a01001_html"><div class="ttname"><a href="a01001.html">atca_command</a></div><div class="ttdoc">atca_command is the C object backing ATCACommand.</div><div class="ttdef"><b>Definition:</b> atca_command.h:52</div></div>
<div class="ttc" id="a00173_html_a22bd6643f31f1d75dc3e7ea939f468cd"><div class="ttname"><a href="a00173.html#a22bd6643f31f1d75dc3e7ea939f468cd">ATCA_STATUS</a></div><div class="ttdeci">ATCA_STATUS</div><div class="ttdef"><b>Definition:</b> atca_status.h:41</div></div>
<div class="ttc" id="a00170_html"><div class="ttname"><a href="a00170.html">atca_iface.h</a></div><div class="ttdoc">Microchip Crypto Auth hardware interface object.</div></div>
<div class="ttc" id="a00988_html_gad5e12e12d3030e28d75164286df9e5e9"><div class="ttname"><a href="a00988.html#gad5e12e12d3030e28d75164286df9e5e9">newATCADevice</a></div><div class="ttdeci">ATCADevice newATCADevice(ATCAIfaceCfg *cfg)</div><div class="ttdoc">constructor for a Microchip CryptoAuth device</div><div class="ttdef"><b>Definition:</b> atca_device.c:41</div></div>
<div class="ttc" id="a01041_html"><div class="ttname"><a href="a01041.html">atca_iface</a></div><div class="ttdoc">atca_iface is the C object backing ATCAIface. See the atca_iface.h file for details on the ATCAIface ...</div><div class="ttdef"><b>Definition:</b> atca_iface.h:129</div></div>
<div class="ttc" id="a00146_html"><div class="ttname"><a href="a00146.html">atca_command.h</a></div><div class="ttdoc">Microchip Crypto Auth device command object - this is a command builder only, it does not send the co...</div></div>
<div class="ttc" id="a01009_html"><div class="ttname"><a href="a01009.html">atca_device</a></div><div class="ttdoc">atca_device is the C object backing ATCADevice. See the atca_device.h file for details on the ATCADev...</div><div class="ttdef"><b>Definition:</b> atca_device.h:44</div></div>
<div class="ttc" id="a00988_html_ga8eec7f2190d1f9bda6684f5d2177db15"><div class="ttname"><a href="a00988.html#ga8eec7f2190d1f9bda6684f5d2177db15">initATCADevice</a></div><div class="ttdeci">ATCA_STATUS initATCADevice(ATCAIfaceCfg *cfg, ATCADevice ca_dev)</div><div class="ttdoc">Initializer for an Microchip CryptoAuth device.</div><div class="ttdef"><b>Definition:</b> atca_device.c:118</div></div>
<div class="ttc" id="a00988_html_gaa94f7bb4af0a3d6735225cc85d92cb50"><div class="ttname"><a href="a00988.html#gaa94f7bb4af0a3d6735225cc85d92cb50">ATCADevice</a></div><div class="ttdeci">struct atca_device * ATCADevice</div><div class="ttdef"><b>Definition:</b> atca_device.h:50</div></div>
<div class="ttc" id="a00988_html_gab729e6c838c0a247d4f226fb92492d96"><div class="ttname"><a href="a00988.html#gab729e6c838c0a247d4f226fb92492d96">releaseATCADevice</a></div><div class="ttdeci">ATCA_STATUS releaseATCADevice(ATCADevice ca_dev)</div><div class="ttdoc">Release any resources associated with the device.</div><div class="ttdef"><b>Definition:</b> atca_device.c:164</div></div>
<div class="ttc" id="a01009_html_aac7a3ed180ba0fcf0d86f7b54ebc1379"><div class="ttname"><a href="a01009.html#aac7a3ed180ba0fcf0d86f7b54ebc1379">atca_device::mCommands</a></div><div class="ttdeci">ATCACommand mCommands</div><div class="ttdoc">Command set for a given CryptoAuth device.</div><div class="ttdef"><b>Definition:</b> atca_device.h:46</div></div>
<div class="ttc" id="a01013_html"><div class="ttname"><a href="a01013.html">ATCAIfaceCfg</a></div><div class="ttdef"><b>Definition:</b> atca_iface.h:66</div></div>
<div class="ttc" id="a00993_html_gabe78755474c1323a5ac7b3dd6d03dedf"><div class="ttname"><a href="a00993.html#gabe78755474c1323a5ac7b3dd6d03dedf">dev</a></div><div class="ttdeci">char * dev</div><div class="ttdef"><b>Definition:</b> hal_linux_kit_cdc.c:59</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_97aefd0d527b934f1d99a682da8fe6a9.html">lib</a></li><li class="navelem"><a class="el" href="a00155.html">atca_device.h</a></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
